<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>py2ecotect.ent.zone.Zone</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="py2ecotect-module.html">Package&nbsp;py2ecotect</a> ::
        <a href="py2ecotect.ent-module.html">Package&nbsp;ent</a> ::
        <a href="py2ecotect.ent.zone-module.html">Module&nbsp;zone</a> ::
        Class&nbsp;Zone
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="py2ecotect.ent.zone.Zone-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Zone</h1><p class="nomargin-top"><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone">source&nbsp;code</a></span></p>
<pre class="base-tree">
object --+
         |
        <strong class="uidshort">Zone</strong>
</pre>

<hr />
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">zone_eco_id</span>)</span><br />
      x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#delete" class="summary-sig-name">delete</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Use this method to delete the specified zone and all the objects it 
      contains.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.delete">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#extrude" class="summary-sig-name">extrude</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">offset_distance</span>)</span><br />
      Extrudes the FLOOR object(s) in the specified zone a distance of (dx,
      dy, dz) in the major axis.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.extrude">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#isolate" class="summary-sig-name">isolate</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Hides all other zones and isolates the specified zone within the 
      current view.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.isolate">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#move" class="summary-sig-name">move</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">offset_distance</span>)</span><br />
      Moves all objects in the specified zone a distance of dx , dy and dz 
      in the major axis.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.move">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#nudge" class="summary-sig-name">nudge</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">dir</span>)</span><br />
      Nudges the all objects in the specified zone in the given axis.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.nudge">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#rotate" class="summary-sig-name">rotate</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">azi</span>,
        <span class="summary-sig-arg">alt</span>)</span><br />
      Rotates all objects in the specified zone about the Transformation 
      Origin (see set.model.origin).</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.rotate">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#rotate_axis" class="summary-sig-name">rotate_axis</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">rotation_degree</span>)</span><br />
      Rotates all objects in the specified zone about the Transformation 
      Origin (see set.model.origin).</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.rotate_axis">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#rotate_reverse" class="summary-sig-name">rotate_reverse</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">azi</span>,
        <span class="summary-sig-arg">alt</span>)</span><br />
      Rotates all objects in the specified zone about the Transformation 
      Origin (see set.model.origin).</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.rotate_reverse">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#scale" class="summary-sig-name">scale</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">scale_factor</span>)</span><br />
      Scales all objects in the specified zone by a factor of sx, sy and sz
      in the major axis.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.scale">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#xform" class="summary-sig-name">xform</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">trans</span>,
        <span class="summary-sig-arg">function_values</span>)</span><br />
      Apply a generic transform to all objects in the specified zone.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.xform">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#get_colour" class="summary-sig-name">get_colour</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Retrieves the colour of the specified zone.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_colour">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#set_colour" class="summary-sig-name">set_colour</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">display</span>,
        <span class="summary-sig-arg">shadow</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">0x000000</code><code class="variable-quote">'</code></span>,
        <span class="summary-sig-arg">reflection</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">000000</code><code class="variable-quote">'</code></span>)</span><br />
      Sets the colour or colours of the specified zone.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.set_colour">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#get_comfort" class="summary-sig-name">get_comfort</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">day</span>,
        <span class="summary-sig-arg">hour</span>)</span><br />
      Retrieves the number of hours the specified zone spent at the given 
      temperature.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_comfort">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#get_cooling" class="summary-sig-name">get_cooling</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">month</span>)</span><br />
      Retrieves the total monthly cooling load for the zone during the 
      given month.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_cooling">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#get_distribution" class="summary-sig-name">get_distribution</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">temperature</span>)</span><br />
      Retrieves the number of hours the specified zone spent at the given 
      temperature.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_distribution">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#get_flag" class="summary-sig-name">get_flag</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">flag</span>)</span><br />
      In ECOTECT, zone have a range of boolean flags associated with them 
      that are used at various times.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_flag">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#set_flag" class="summary-sig-name">set_flag</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">flag</span>,
        <span class="summary-sig-arg">state</span>=<span class="summary-sig-default">True</span>)</span><br />
      In ECOTECT, zone have a range of boolean flags associated with them that 
are used at various times.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.set_flag">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#get_group_hidden" class="summary-sig-name">get_group_hidden</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">group</span>)</span><br />
      Retrieves the hidden state of the specified zone group.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_group_hidden">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#set_group_hidden" class="summary-sig-name">set_group_hidden</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">group</span>,
        <span class="summary-sig-arg">hidden</span>)</span><br />
      Sets the hidden state of all zones in the specified zone group.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.set_group_hidden">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#get_group_index" class="summary-sig-name">get_group_index</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">name</span>)</span><br />
      Retrieves the index (0-15) the specified zone group name.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_group_index">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#get_group_locked" class="summary-sig-name">get_group_locked</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">group</span>)</span><br />
      Retrieves the locked state of the specified zone group.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_group_locked">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#set_group_locked" class="summary-sig-name">set_group_locked</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">group</span>,
        <span class="summary-sig-arg">locked</span>)</span><br />
      Sets the locked state of all zones in the specified zone group.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.set_group_locked">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#get_group_name" class="summary-sig-name">get_group_name</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">group</span>,
        <span class="summary-sig-arg">nospaces</span>=<span class="summary-sig-default">False</span>)</span><br />
      Retrieves the name of the specified zone group.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_group_name">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#set_group_name" class="summary-sig-name">set_group_name</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">group</span>,
        <span class="summary-sig-arg">name</span>)</span><br />
      Sets the name of the specified zone group.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.set_group_name">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#get_group_off" class="summary-sig-name">get_group_off</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">group</span>)</span><br />
      Retrieves the off state of the specified zone group.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_group_off">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#set_group_off" class="summary-sig-name">set_group_off</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">group</span>,
        <span class="summary-sig-arg">off</span>)</span><br />
      Sets the off state of all zones in the specified zone group.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.set_group_off">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#get_group_thermal" class="summary-sig-name">get_group_thermal</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">group</span>)</span><br />
      Retrieves the thermal state of the specified zone group.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_group_thermal">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#set_group_thermal" class="summary-sig-name">set_group_thermal</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">group</span>,
        <span class="summary-sig-arg">thermal</span>)</span><br />
      Sets the thermal state of all zones in the specified zone group.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.set_group_thermal">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#get_heating" class="summary-sig-name">get_heating</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">month</span>)</span><br />
      Retrieves the total monthly heating load for the zone during the 
      given month.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_heating">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#get_index" class="summary-sig-name">get_index</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">name</span>)</span><br />
      This property returns the zero-based index of the zone with a name 
      matching the name parameter.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_index">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#get_ingroup" class="summary-sig-name">get_ingroup</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">group</span>)</span><br />
      Determines if the specified zone belongs to the given zone group.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_ingroup">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#get_next_object" class="summary-sig-name">get_next_object</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">startat</span>,
        <span class="summary-sig-arg">type</span>,
        <span class="summary-sig-arg">flag</span>,
        <span class="summary-sig-arg">tag</span>)</span><br />
      Use this property to obtain the zero-based index of the next object 
      matching the type, flag and tag values specified, but belonging to 
      the specificed zone.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_next_object">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#get_occupancy" class="summary-sig-name">get_occupancy</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Retrieves the number of people within the specified zone.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_occupancy">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#set_occupancy" class="summary-sig-name">set_occupancy</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">people</span>,
        <span class="summary-sig-arg">percentagefull</span>=<span class="summary-sig-default">0.0</span>,
        <span class="summary-sig-arg">seatingtype</span>=<span class="summary-sig-default">0</span>)</span><br />
      Sets the number of people within the specified zone.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.set_occupancy">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#get_operation" class="summary-sig-name">get_operation</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Retrieves the current hourly on/off times for the occupancy or HVAC 
      system in the specified zone.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_operation">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#set_operation" class="summary-sig-name">set_operation</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">wkdayon</span>,
        <span class="summary-sig-arg">wkdayoff</span>,
        <span class="summary-sig-arg">wkendon</span>,
        <span class="summary-sig-arg">wkendoff</span>)</span><br />
      Sets the current hourly on/off times for the occupancy or HVAC system
      in the specified zone.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.set_operation">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#get_reverb_time" class="summary-sig-name">get_reverb_time</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">octave</span>)</span><br />
      Retrieves the reverberation time for the given zone at the specified 
      octave.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_reverb_time">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#get_schedules" class="summary-sig-name">get_schedules</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Retrieves the control schedule indexes for zone occupancy, 
      ventilation and internal gain.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_schedules">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#set_schedules" class="summary-sig-name">set_schedules</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">occIndex</span>,
        <span class="summary-sig-arg">ventIndex</span>,
        <span class="summary-sig-arg">gainsIndex</span>)</span><br />
      Sets the control schedule indexes for zone occupancy, ventilation and
      internal gain.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.set_schedules">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#get_temperature" class="summary-sig-name">get_temperature</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">hour</span>)</span><br />
      Retrieves the temperature of the zone at the specified hour.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_temperature">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__str__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== STATIC METHODS ==================== -->
<a name="section-StaticMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Static Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-StaticMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.zone.Zone-class.html#create_zone" class="summary-sig-name">create_zone</a>(<span class="summary-sig-arg">name</span>)</span><br />
      Use this command to create new zones in the model.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.create_zone">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Properties</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Properties"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#eco_id" class="summary-name">eco_id</a><br />
      Id of the zone object
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#activity" class="summary-name">activity</a><br />
      Retrieves the occupant activity rate in the specified zone.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#admittance" class="summary-name">admittance</a><br />
      Retrieves the specified zone's current value for the total zone 
      admittance (W/m^2K).
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#air_speed" class="summary-name">air_speed</a><br />
      Retrieves the specified zone's current value for the designed 
      internal air-speed (m/s).
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#appliance_energy" class="summary-name">appliance_energy</a><br />
      Retrieves the specified zone's current value for the total energy 
      gain from APPLIANCE objects.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#clothing" class="summary-name">clothing</a><br />
      Retrieves the specified zone's current value for the design clothing 
      value of occupants (clo).
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#current" class="summary-name">current</a><br />
      Determine if the specified zone is the current zone.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#efficiency" class="summary-name">efficiency</a><br />
      Retrieves the specified zone's current value for the HVAC system 
      efficiency (%).
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#equator_area" class="summary-name">equator_area</a><br />
      Retrieves the specified zone's current value for the total exposed 
      WINDOW area facing the equator (m^).
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#exposed_area" class="summary-name">exposed_area</a><br />
      Retrieves the specified zone's current value for the total surface 
      area exposed to outside conditions (m^2).
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#floor_area" class="summary-name">floor_area</a><br />
      Retrieves the specified zone's current value for the total zone floor
      area (m^2).
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#hidden" class="summary-name">hidden</a><br />
      Retrieves the current hidden state of the specified zone.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#infiltration_rate" class="summary-name">infiltration_rate</a><br />
      Retrieves the specified zone's current value for the air infiltration
      rate (ac/h).
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#internal_gains" class="summary-name">internal_gains</a><br />
      Retrieves the specified zone's current value for the total internally
      generated heat gains (W).
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#interzonal_gains" class="summary-name">interzonal_gains</a><br />
      Retrieves the specified zone's current value for the total gains 
      flowing to/from other adjacent zones (W).
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#latent_gains" class="summary-name">latent_gains</a><br />
      Retrieves the specified zone's current value for the latent internal 
      heat gains (W/m^2).
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#lighting_energy" class="summary-name">lighting_energy</a><br />
      Retrieves the specified zone's current value for the total energy 
      gain from LIGHT objects.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#locked" class="summary-name">locked</a><br />
      Retrieves the current locked state of the specified zone.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#lower_band" class="summary-name">lower_band</a><br />
      Retrieves the specified zone's current value for the lower comfort 
      band ( deg Celsius).
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#lux" class="summary-name">lux</a><br />
      Retrieves the specified zone's current value for the design internal 
      lighting level (lux).
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#method_reverb" class="summary-name">method_reverb</a><br />
      Retrieves the specified zone's current value for the reverberation 
      calculation method.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#name" class="summary-name">name</a><br />
      Returns the zone's name.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#objects" class="summary-name">objects</a><br />
      Returns the zone's object(s).
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#off" class="summary-name">off</a><br />
      Retrieves the current off state of the specified zone.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#peak_cooling" class="summary-name">peak_cooling</a><br />
      Retrieves the specified zone's current value for the peak cooling 
      load (W).
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#peak_heating" class="summary-name">peak_heating</a><br />
      Retrieves the specified zone's current value for the peak heating 
      load (W).
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#random_colour" class="summary-name">random_colour</a>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#range" class="summary-name">range</a><br />
      Retrieves the minimum, maximum and average temperature of the zone 
      for the last calculated day.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#rel_humidity" class="summary-name">rel_humidity</a><br />
      Retrieves the specified zone's current value for the design internal 
      relative humidity (%).
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#response_factor" class="summary-name">response_factor</a><br />
      Retrieves the specified zone's current value for the total zone 
      response factor.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#selected" class="summary-name">selected</a>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#sensible_gains" class="summary-name">sensible_gains</a><br />
      Retrieves the specified zone's current value for the sensible 
      internal heat gains (W/m^2).
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#solar_gains" class="summary-name">solar_gains</a><br />
      Retrieves the specified zone's current value for the total direct 
      solar gains through WINDOWS and transparent appertures.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#surface_area" class="summary-name">surface_area</a><br />
      Retrieves the specified zone's current value for the total zone 
      internal surface area (m^2).
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#system" class="summary-name">system</a><br />
      Retrieves the HVAC system type for the specified zone.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#thermal" class="summary-name">thermal</a><br />
      Retrieves the current thermal state of the specified zone.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#upper_band" class="summary-name">upper_band</a><br />
      Retrieves the specified zone's current value for the upper comfort 
      band (deg celsius).
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#uvalue" class="summary-name">uvalue</a><br />
      Retrieves the specified zone's current value for the total U-Value of
      exposed surface area (Heat loss rate W/m K).
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#ventilation_rate" class="summary-name">ventilation_rate</a><br />
      Retrieves the specified zone's current value for the wind-driven 
      ventilation rate (ac/h).
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#volume" class="summary-name">volume</a><br />
      Retrieves the specified zone's current value for the internal zone 
      volume (m^3).
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.ent.zone.Zone-class.html#window_area" class="summary-name">window_area</a><br />
      Retrieves the specified zone's current value for the total exposed 
      WINDOW area (m^2).
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">zone_eco_id</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>x.__init__(...) initializes x; see x.__class__.__doc__ for 
  signature</p>
  <dl class="fields">
    <dt>Overrides:
        object.__init__
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="create_zone"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">create_zone</span>(<span class="sig-arg">name</span>)</span>
    <br /><em class="fname">Static Method</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.create_zone">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Use this command to create new zones in the model. It returns the 
  zero-based index of the zone just added which you can then use to edit 
  properties.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>name A text string containing the name of the zone to create. If this 
  name already exists, it will be incremented by adding '(X)' to the end, 
  where X is the first unique name.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>zoneIndex The zone object just added. A value of -1 indicates that the
  operation failed.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="delete"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">delete</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.delete">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Use this method to delete the specified zone and all the objects it 
  contains.</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="extrude"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">extrude</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">offset_distance</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.extrude">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Extrudes the FLOOR object(s) in the specified zone a distance of (dx, 
  dy, dz) in the major axis.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>offset_distance A list of three values representing the offset 
  distance in each of the X, Y and Z axis, given in model coordinates.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="isolate"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">isolate</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.isolate">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Hides all other zones and isolates the specified zone within the 
  current view. Effectively the same as interactively pressing the F4 
  key.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="move"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">move</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">offset_distance</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.move">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Moves all objects in the specified zone a distance of dx , dy and dz 
  in the major axis.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>offset_distance A list of three values representing the offset 
  distance in each of the X, Y and Z axis, given in model coordinates.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="nudge"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">nudge</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">dir</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.nudge">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Nudges the all objects in the specified zone in the given axis.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>dir An integer value corresponding to the Nudge Direction table 
  below.</p>
  <p>Relevant Data Table(s)</p>
  <p>Nudge Directions Value Description 1, -1 In the X axis. 2, -2 In the Y
  axis. 3, -3 In the Z axis.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="rotate"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">rotate</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">azi</span>,
        <span class="sig-arg">alt</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.rotate">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Rotates all objects in the specified zone about the Transformation 
  Origin (see set.model.origin). Rotation is done about the Y axis first 
  (altitude) and then the Z axis (aziumuth).</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>azi The azimuth value in degrees.</p>
  <p>alt The altitude value in degrees.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="rotate_axis"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">rotate_axis</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">rotation_degree</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.rotate_axis">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Rotates all objects in the specified zone about the Transformation 
  Origin (see set.model.origin). Rotation is done by the given angles in 
  each axis.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>rotation_degree A list of three values representing the degrees of 
  rotation in each of the X, Y, Z Axis.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="rotate_reverse"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">rotate_reverse</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">azi</span>,
        <span class="sig-arg">alt</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.rotate_reverse">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Rotates all objects in the specified zone about the Transformation 
  Origin (see set.model.origin). Rotation is done about the Z axis first 
  (altitude) and then the Y axis (aziumuth).</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>azi The azimuth value in degrees.</p>
  <p>alt The altitude value in degrees.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="scale"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">scale</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">scale_factor</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.scale">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Scales all objects in the specified zone by a factor of sx, sy and sz 
  in the major axis.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>scale_factor A list of three values representing the scaling factor in
  each of the X, Y and Z axis.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="xform"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">xform</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">trans</span>,
        <span class="sig-arg">function_values</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.xform">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Apply a generic transform to all objects in the specified zone.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>trans The transformation to use, given as a token corresponding to the
  Transformation Types table.</p>
  <p>function_values A list of three values specified by the table 
  below.</p>
  <p>Relevant Data Table(s)</p>
  <p>Transformation Types Token Description axis Axial rotation, where x , 
  y and z are axial angles in degrees. reverse Reverse polar rotation, 
  where x and y are azi and alt in degrees. rotate Polar rotation, where x 
  and y are azi and alt in degrees. move Translate objects by x , y and z 
  values in the major axis. scale Scale objects by x , y and z in the major
  axis. mirror Mirror objects around About Point and vector formed by x , y
  and z. normal Extrude objects a distance of x along its surface normal. 
  extrude Extrude objects by x , y and z in the major axis. revolve Revolve
  objects around axis x , y degrees and in z segments. nudge Nudge objects 
  a distance of x , y and z in the major axis.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_colour"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_colour</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_colour">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the colour of the specified zone.</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>dcolor The displayed colour of the zone as a full hexidecimal 
  value.</p>
  <p>scolor The colour of shadow the zone projects as a full hexidecimal 
  value.</p>
  <p>rcolor The colour of reflection the zone project as a full hexidecimal
  value.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_colour"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_colour</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">display</span>,
        <span class="sig-arg">shadow</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">0x000000</code><code class="variable-quote">'</code></span>,
        <span class="sig-arg">reflection</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">000000</code><code class="variable-quote">'</code></span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.set_colour">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the colour or colours of the specified zone.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>display The colour of the zone as a full hexidecimal value (eg: 
  0xFF8800).</p>
  <p>[shadow] This optional parameter specifies the colour of the shadow 
  generated by the zone, given as a full hexideciman value (eg: 
  0xFF8800).</p>
  <p>[reflection] This optional parameter specifies the colour of the 
  reflection generated by the zone, given as a full hexideciman value (eg: 
  0xFF8800).</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_comfort"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_comfort</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">day</span>,
        <span class="sig-arg">hour</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_comfort">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the number of hours the specified zone spent at the given 
  temperature. This value is only valid after a Temperature Distribution 
  calculation has been performed.</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <p>day An integer value between 1 and 365 representing the day of the 
  year.</p>
  <p>hour An integer value between 0 and 23 representing the hour of the 
  day.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>pmv The Predicted Mean Vote value between -3 and +3.</p>
  <p>ppd The Percentage People Dissatisfied between 5% (losest) and 100% 
  (everyone).</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_cooling"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_cooling</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">month</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_cooling">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the total monthly cooling load for the zone during the given
  month.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>month A value between 0 and 11 representing the month to retrieve the 
  value from.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>result The cooling load value for the given month.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_distribution"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_distribution</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">temperature</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_distribution">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the number of hours the specified zone spent at the given 
  temperature. This value is only valid after a Temperature Distribution 
  calculation has been performed.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>temperature The temperature in degrees celsius.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>result The hour count spent at the given temperature.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_flag"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_flag</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">flag</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_flag">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>In ECOTECT, zone have a range of boolean flags associated with them 
  that are used at various times. This property retrieves the nominated 
  flag settings for the specified zone.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>flag An integer value representing a binary bit as shown in the Zone 
  Flag Codes table below. To test multiple flags at once, simply add their 
  values together.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>result A boolean value where 1 represents true if the flag is set and 
  0 or false if the flag is not set.</p>
  <p>Relevant Data Table(s)</p>
  <p>Zone Flag Codes No. Flag Name 1 VOLUME_OK 2 THERMAL_OK 4 MATERIALS_OK 
  8 DELETED 16 OFF 32 LOCKED 64 THERMAL 128 HIDDEN 256 SELECTED 512 
  CROSSVENT 1024 SINGLE_SIDED 2048 UNDO_FLAG 4096 COMFORT 8192 TEMPERATURES
  16384 HEAT_LOADS 32768 SHADOWCOLOR 65536 MALFORMED 131072 NO_EXPORT 
  1048576 LIST_REFRESH 8388608 NO_SHADOWS 16777216 NO_OUTLINE</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_flag"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_flag</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">flag</span>,
        <span class="sig-arg">state</span>=<span class="sig-default">True</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.set_flag">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">


In ECOTECT, zone have a range of boolean flags associated with them that 
are used at various times. This property sets the nominated flag 
settings for the specified zone.

Important Note: Flags are fundamental to how the model works. Be very 
careful before setting any of them manually, and always operate on files 
for which you have up-to-date backups. Incorrect usage of flags can 
corrupt your model beyond repair (ECOTECT probably shouldn't allow these 
values to be set via a script, however someone will have a valid reason 
at some stage, and if the user cannot be trusted, who can be trusted?). 

Parameter(s)
This property takes the following parameters.

flag 
An integer value representing a binary bit, as shown in the Zone Flag 
Codes table. To set multiple flags at once, simply add their values 
together. 

state 
A boolean value representing the desired state of the flag, where 1 or 
true sets the flag and 0 or false clears it. This parameter defaults to 
true if not specified. 

Relevant Data Table(s)

 Zone Flag Codes 
 No. Flag Name 
1 VOLUME_OK 
2 THERMAL_OK 
4 MATERIALS_OK 
8 DELETED 
16 OFF 
32 LOCKED 
64 THERMAL 
128 HIDDEN 
256 SELECTED 
512 CROSSVENT 
1024 SINGLE_SIDED 
2048 UNDO_FLAG 
4096 COMFORT 
8192 TEMPERATURES 
16384 HEAT_LOADS 
32768 SHADOWCOLOR 
65536 MALFORMED 
131072 NO_EXPORT 
1048576 LIST_REFRESH 
8388608 NO_SHADOWS 
16777216 NO_OUTLINE 

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_group_hidden"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_group_hidden</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">group</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_group_hidden">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the hidden state of the specified zone group. Hidden zones 
  still take part in all analytical calculations, but are not visible in 
  the current model view.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>group The zero-based index of the required zone group (0-15).</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>result A boolean value where 1 represents true and 0 represents 
  false.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_group_hidden"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_group_hidden</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">group</span>,
        <span class="sig-arg">hidden</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.set_group_hidden">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the hidden state of all zones in the specified zone group. Hidden
  zones still take part in all analytical calculations, but are not visible
  in the current model view.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>group The zero-based index of the required zone group (0-15).</p>
  <p>hidden A boolean value where 1 or true represents the affirmative and 
  0 or false the negative.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_group_index"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_group_index</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">name</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_group_index">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the index (0-15) the specified zone group name.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>name The name of the zone group to find the index of.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>result The zero-based index of the matching zone group (0-15). if no 
  match is found, the value -1 is returned.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_group_locked"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_group_locked</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">group</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_group_locked">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the locked state of the specified zone group. Locked zones 
  are still displayed and take part in calculations, but the user cannot 
  interactively select or manipulate them.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>group The zero-based index of the required zone group (0-15).</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>result A boolean value where 1 represents true and 0 represents 
  false.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_group_locked"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_group_locked</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">group</span>,
        <span class="sig-arg">locked</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.set_group_locked">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the locked state of all zones in the specified zone group. Locked
  zones are still displayed and take part in calculations, but the user 
  cannot interactively select or manipulate them.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>group The zero-based index of the required zone group (0-15).</p>
  <p>locked A boolean value where 1 or true represents the affirmative and 
  0 or false the negative.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_group_name"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_group_name</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">group</span>,
        <span class="sig-arg">nospaces</span>=<span class="sig-default">False</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_group_name">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the name of the specified zone group.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>group The zero-based index of the required zone group (0-15).</p>
  <p>[nospaces] An optional boolean true/false parameter specifying that 
  the returned name should have all spaces replaced by the underscore ('_')
  character. The default values for this parameters is false.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>result A test string containing the name of the specfied group.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_group_name"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_group_name</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">group</span>,
        <span class="sig-arg">name</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.set_group_name">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the name of the specified zone group.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>group The zero-based index of the required zone group (0-15).</p>
  <p>name The name of the specfied group.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_group_off"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_group_off</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">group</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_group_off">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the off state of the specified zone group. Off zones are 
  effectively removed from the mode and are not displayed or involved in 
  any calculations.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>group The zero-based index of the required zone group (0-15).</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>result A boolean value where 1 represents true and 0 represents 
  false.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_group_off"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_group_off</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">group</span>,
        <span class="sig-arg">off</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.set_group_off">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the off state of all zones in the specified zone group. Off zones
  are effectively removed from the mode and are not displayed or involved 
  in any calculations.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>group The zero-based index of the required zone group (0-15).</p>
  <p>off A boolean value where 1 or true represents the affirmative and 0 
  or false the negative.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_group_thermal"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_group_thermal</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">group</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_group_thermal">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the thermal state of the specified zone group. Thermal zones
  are treated as fully enclosed spaces or rooms for which volume, 
  temperature and acoustic data is calculated.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>group The zero-based index of the required zone group (0-15).</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>result A boolean value where 1 represents true and 0 represents 
  false.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_group_thermal"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_group_thermal</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">group</span>,
        <span class="sig-arg">thermal</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.set_group_thermal">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the thermal state of all zones in the specified zone group. 
  Thermal zones are treated as fully enclosed spaces or rooms for which 
  volume, temperature and acoustic data is calculated.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>group The zero-based index of the required zone group (0-15).</p>
  <p>thermal A boolean value where 1 or true represents the affirmative and
  0 or false the negative.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_heating"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_heating</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">month</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_heating">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the total monthly heating load for the zone during the given
  month.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>zone The zero-based index value of the zone.</p>
  <p>month A value between 0 and 11 representing the month to retrieve the 
  value from.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>result The heating load in Wh for the given month.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_index"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_index</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">name</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_index">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>This property returns the zero-based index of the zone with a name 
  matching the name parameter.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>name A string value representing the name of the zone.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>index The zero-based index of the matching zone. If no matching zone 
  is found, an index of -1 is returned.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_ingroup"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_ingroup</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">group</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_ingroup">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Determines if the specified zone belongs to the given zone group.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>zone The zero-based index of the zone to be tested.</p>
  <p>group The zero-based index of the zone group (0-15) to test 
  against.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>belongs A boolean value where 1 represents true and 0 represents 
  false.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_next_object"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_next_object</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">startat</span>,
        <span class="sig-arg">type</span>,
        <span class="sig-arg">flag</span>,
        <span class="sig-arg">tag</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_next_object">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Use this property to obtain the zero-based index of the next object 
  matching the type, flag and tag values specified, but belonging to the 
  specificed zone.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>startat The index value to start searching from. To search from the 
  start, use a value of -1.</p>
  <p>type The element type, as outlined in the Element Types table below. 
  To ignore this parameter, enter a negative value, such as -1.</p>
  <p>flag The boolean flags from the Object Flags table. To combine 
  multiple flag values, add their numeric values together. To ignore this 
  parameter, enter a negative value, such as -1.</p>
  <p>tag The boolean tag parameter from the Object Tags table. To combine 
  multiple tag values, add their numeric values together. To ignore this 
  parameter, enter a negative value, such as -1.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>index The zero-based index of the next matching object. If no object 
  is found, a value of -1 is returned.</p>
  <p>Relevant Data Table(s)</p>
  <p>Element Types</p>
  <p>Token Value void 0 roof 1 floor 2 ceiling 3 wall 4 partition 5 window 
  6 panel 7 door 8 point 9 speaker 10 light 11 appliance 12 line 13 
  solarcollector 14 camera 15</p>
  <p>Object Flag Codes Value Description 1 Object is a single-node point. 2
  Object is a direction vector. 4 Object is a flat surface with an 
  equation. 8 Objects is a closed loop. 16 Object defines a virtual 
  polyline. 32 Object is formed from the extrusion of its parent. 64 Object
  has been extruded. 128 Object is linked to another as coplanar. 256 
  Object is linked to another as inside its extents. 512 Object is a 
  complex/concave polygon. 1024 Object is the parent of another. 2048 
  Object is the child of another. 4096 Object defines a model zone. 8192 
  *User has specified particular nodes to generate equation. 16384 Object's
  surface normal is reversed. 32768 Object is partially transparent.</p>
  <p>Object Tag Codes Value Description 1 *User clicked near one of its 
  lines. 2 *Part of the previous selection set. 16 Object has valid 
  assigned attribute data. 32 Shadows are cast onto this object. 256 Object
  produces solar reflections. 512 Object is tagged as an acoustic 
  reflector. 4096 Not used. 32768 *Generic calculation marker.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_occupancy"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_occupancy</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_occupancy">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the number of people within the specified zone.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>people A value representing the number of people in the zone.</p>
  <p>full The current percentage of maximum zone occupancy.</p>
  <p>seatingtype The seating type corresponding to the Zone Seating Codes 
  table below.</p>
  <p>Relevant Data Table(s)</p>
  <p>Zone Seating Codes Value Description 0 None 1 Upholstered seating 2 
  Cloth covered seating 3 Hard-backed seating</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_occupancy"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_occupancy</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">people</span>,
        <span class="sig-arg">percentagefull</span>=<span class="sig-default">0.0</span>,
        <span class="sig-arg">seatingtype</span>=<span class="sig-default">0</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.set_occupancy">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the number of people within the specified zone.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>people A value representing the number of people.</p>
  <p>[percentagefull] This optional parameter specifies the percentage of 
  the zone that is occupied.</p>
  <p>[seatingtype] This optional parameter specifies the seating type and 
  corresponds to the Zone Seating Codes table below.</p>
  <p>Relevant Data Table(s)</p>
  <p>Zone Seating Codes Value Description 0 None 1 Upholstered seating 2 
  Cloth covered seating 3 Hard-backed seating</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_operation"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_operation</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_operation">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the current hourly on/off times for the occupancy or HVAC 
  system in the specified zone.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>wkdayon A value between 0 and 23 representing the on hour on a 
  weekday.</p>
  <p>wkdayoff A value between 0 and 23 representing the off hour on a 
  weekday.</p>
  <p>wkendon A value between 0 and 23 representing the on hour on a 
  weekend.</p>
  <p>wkendoff A value between 0 and 23 representing the on hour off a 
  weekend.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_operation"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_operation</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">wkdayon</span>,
        <span class="sig-arg">wkdayoff</span>,
        <span class="sig-arg">wkendon</span>,
        <span class="sig-arg">wkendoff</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.set_operation">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the current hourly on/off times for the occupancy or HVAC system 
  in the specified zone.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>wkdayon A value between 0 and 23 representing the on hour on a 
  weekday.</p>
  <p>wkdayoff A value between 0 and 23 representing the off hour on a 
  weekday.</p>
  <p>wkendon A value between 0 and 23 representing the on hour on a 
  weekend.</p>
  <p>wkendoff A value between 0 and 23 representing the on hour off a 
  weekend.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_reverb_time"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_reverb_time</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">octave</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_reverb_time">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the reverberation time for the given zone at the specified 
  octave. This value is only valid after a Statistical Reverberation Time 
  calculation has been performed.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>octave An integer value ranging from 0 to 8, where 0 is 63Hz, 1 is 
  125Hz, 2 is 250Hz right up to 8 which means 16kHz - as shown in the 
  Centre Frequencies table below.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>result The zone's reverberation time in decimal seconds.</p>
  <p>Relevant Data Table(s)</p>
  <p>Octave Frequencies Value Frequency 0 63 Hz 1 125 Hz 2 250 Hz 3 500 Hz 
  4 1000 Hz 5 2000 Hz 6 4000 Hz 7 8000 Hz 8 16000 Hz</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_schedules"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_schedules</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_schedules">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the control schedule indexes for zone occupancy, ventilation
  and internal gain.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>occIndex The zero-based index of the zone's occupancy schedule.</p>
  <p>ventIndex The zero-based index of the zone's infiltration/ventilation 
  schedule.</p>
  <p>gainsIndex The zero-based index of the zone's internal gains 
  schedule.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_schedules"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_schedules</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">occIndex</span>,
        <span class="sig-arg">ventIndex</span>,
        <span class="sig-arg">gainsIndex</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.set_schedules">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the control schedule indexes for zone occupancy, ventilation and 
  internal gain. Each value is a zero based index into the schedule list. 
  You can obtain these indexes from the schedule name using the 
  get.schedule.index command.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>occIndex A value corresponding to the zero-based index of a 
  schedule.This index is obtainable through the use of the 
  get.schedule.index command.</p>
  <p>ventIndex A value corresponding to the zero-based index of a schedule.
  This index is obtainable through the use of the get.schedule.index 
  command.</p>
  <p>gainsIndex A value corresponding to the zero-based index of a 
  schedule. This index is obtainable through the use of the 
  get.schedule.index command.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_temperature"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_temperature</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">hour</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.zone-pysrc.html#Zone.get_temperature">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the temperature of the zone at the specified hour.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>hour An integer value between 0 and 23 specifying the hour.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>result The temperature value at the given time in degrees celcius.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== PROPERTY DETAILS ==================== -->
<a name="section-PropertyDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Property Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-PropertyDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="eco_id"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">eco_id</h3>
  <p>Id of the zone object</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Id of the zone object
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="activity"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">activity</h3>
  <p>Retrieves the occupant activity rate in the specified zone.</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>result The activity rate index based on the following Zone Activity 
  Rates table.</p>
  <p>Relevant Data Table(s)</p>
  <p>Zone Activity Rates Token Value Description sedentary 0 Sitting at a 
  desk (70W) walking 1 Moving about (80W) exercising 2 Significant activity
  (100W) strenuous 3 Significant exertion (150W) sleeping 5 Sleeping (40 W,
  0.7 Met) resting 6 Resting (45 W, 0.8 Met) reading 7 Reading (55 W, 1.0 
  Met) typing 8 Typing (65 W, 1.1 Met) clerical 9 Clerical (70 W, 1.2 Met) 
  cooking 10 Cooking, lite (95 W, 1.6 Met) cleaning 12 Cleaning, lite (115 
  W, 2.0 Met) slow walking 13 Slow Walking (115 W, 2.0 Met) dancing 14 
  Dancing, lite (140 W, 2.4 Met) lite execise 16 Light Exercise (175 W, 3.0
  Met) fast walking 17 Fast Walking (200 W, 3.4 Met) hvyexercise 19 
  Exercise, hvy (235 W, 4.0 Met) work 20 Heavy Work (235 W, 4.0 Met) sport 
  22 Team Sport (440 W, 7.6 Met)</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the occupant activity rate in the specified zone.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">type</span>)</span>
        - Sets the average occupant activity rate in the specified zone.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="admittance"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">admittance</h3>
  <p>Retrieves the specified zone's current value for the total zone 
  admittance (W/m^2K).</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the reqested zone data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the specified zone's current value for the total zone admittance 
(W/m^2K).
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">value</span>)</span>
        - Sets the specified zone's value for the total zone admittance (W/m^2K).
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="air_speed"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">air_speed</h3>
  <p>Retrieves the specified zone's current value for the designed internal
  air-speed (m/s).</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the reqested zone data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the specified zone's current value for the designed internal 
air-speed (m/s).
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">value</span>)</span>
        - Sets the specified zone's value for the designed internal air-speed (m/s).
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="appliance_energy"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">appliance_energy</h3>
  <p>Retrieves the specified zone's current value for the total energy gain
  from APPLIANCE objects.</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the reqested zone data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the specified zone's current value for the total energy gain from
APPLIANCE objects.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">value</span>)</span>
        - Sets the specified zone's current value for the total energy gain from 
APPLIANCE objects.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="clothing"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">clothing</h3>
  <p>Retrieves the specified zone's current value for the design clothing 
  value of occupants (clo).</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the reqested zone data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the specified zone's current value for the design clothing value 
of occupants (clo).
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">value</span>)</span>
        - Sets the specified zone's current value for the design clothing value of 
occupants (clo).
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="current"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">current</h3>
  <p>Determine if the specified zone is the current zone. To get the actual
  index of the current zone, use the model.currentzone property.</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>result A boolean value where 1 represents true and 0 represents 
  false.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Determine if the specified zone is the current zone.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>)</span>
        - Sets the specified zone to be the current zone.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="efficiency"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">efficiency</h3>
  <p>Retrieves the specified zone's current value for the HVAC system 
  efficiency (%).</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the reqested zone data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the specified zone's current value for the HVAC system efficiency
(%).
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">value</span>)</span>
        - Sets the specified zone's current value for the HVAC system efficiency (%).
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="equator_area"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">equator_area</h3>
  <p>Retrieves the specified zone's current value for the total exposed 
  WINDOW area facing the equator (m^).</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the reqested zone data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the specified zone's current value for the total exposed WINDOW 
area facing the equator (m^).
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">value</span>)</span>
        - Sets the specified zone's current value for the total exposed WINDOW area 
facing the equator (m^2).
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="exposed_area"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">exposed_area</h3>
  <p>Retrieves the specified zone's current value for the total surface 
  area exposed to outside conditions (m^2).</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the reqested zone data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the specified zone's current value for the total surface area 
exposed to outside conditions (m^2).
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">value</span>)</span>
        - Sets the specified zone's current value for the total surface area exposed 
to outside conditions (m^2).
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="floor_area"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">floor_area</h3>
  <p>Retrieves the specified zone's current value for the total zone floor 
  area (m^2).</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>zone The zero-based index value of the zone.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the reqested zone data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the specified zone's current value for the total zone floor area 
(m^2).
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">value</span>)</span>
        - Sets the specified zone's current value for the total zone floor area 
(m^2).
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="hidden"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">hidden</h3>
  <p>Retrieves the current hidden state of the specified zone. Hidden zones
  still take part in all analytical calculations, but are not visible in 
  the current model view.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>zone The zero-based index value of the zone.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>result A boolean value where 1 represents true and 0 represents 
  false.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the current hidden state of the specified zone.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">state</span>=<span class="summary-sig-default">True</span>)</span>
        - Sets or resets the specified zone's hidden state.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="infiltration_rate"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">infiltration_rate</h3>
  <p>Retrieves the specified zone's current value for the air infiltration 
  rate (ac/h).</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>zone The zero-based index value of the zone.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the reqested zone data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the specified zone's current value for the air infiltration rate 
(ac/h).
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">value</span>)</span>
        - Sets the specified zone's current value for the air infiltration rate 
(ac/h).
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="internal_gains"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">internal_gains</h3>
  <p>Retrieves the specified zone's current value for the total internally 
  generated heat gains (W).</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>zone The zero-based index value of the zone.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the reqested zone data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the specified zone's current value for the total internally 
generated heat gains (W).
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">value</span>)</span>
        - Sets the specified zone's current value for the total internally generated 
heat gains (W).
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="interzonal_gains"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">interzonal_gains</h3>
  <p>Retrieves the specified zone's current value for the total gains 
  flowing to/from other adjacent zones (W).</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>zone The zero-based index value of the zone.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the specified zone's current value for the total gains flowing 
to/from other adjacent zones (W).
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="latent_gains"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">latent_gains</h3>
  <p>Retrieves the specified zone's current value for the latent internal 
  heat gains (W/m^2).</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>zone The zero-based index value of the zone.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the reqested zone data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the specified zone's current value for the latent internal heat 
gains (W/m^2).
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">value</span>)</span>
        - Sets the specified zone's current value for the latent internal heat gains 
(W/m^2).
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="lighting_energy"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">lighting_energy</h3>
  <p>Retrieves the specified zone's current value for the total energy gain
  from LIGHT objects.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>zone The zero-based index value of the zone.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the reqested zone data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the specified zone's current value for the total energy gain from
LIGHT objects.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">value</span>)</span>
        - Sets the specified zone's current value for the total energy gain from 
LIGHT objects.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="locked"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">locked</h3>
  <p>Retrieves the current locked state of the specified zone. Locked zones
  are still displayed and take part in calculations, but the user cannot 
  interactively select or manipulate them.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>zone The zero-based index value of the zone.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>result A boolean value where 1 represents true and 0 represents 
  false.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the current locked state of the specified zone.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">state</span>=<span class="summary-sig-default">True</span>)</span>
        - Sets or resets the specified zone's locked state.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="lower_band"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">lower_band</h3>
  <p>Retrieves the specified zone's current value for the lower comfort 
  band ( deg Celsius).</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>zone The zero-based index value of the zone.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the reqested zone data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the specified zone's current value for the lower comfort band ( 
deg Celsius).
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">value</span>)</span>
        - Sets the specified zone's current value for the lower comfort band (deg 
Celsius).
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="lux"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">lux</h3>
  <p>Retrieves the specified zone's current value for the design internal 
  lighting level (lux).</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>zone The zero-based index value of the zone.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the reqested zone data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the specified zone's current value for the design internal 
lighting level (lux).
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">value</span>)</span>
        - Sets the specified zone's current value for the design internal lighting 
level (lux).
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="method_reverb"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">method_reverb</h3>
  <p>Retrieves the specified zone's current value for the reverberation 
  calculation method.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>zone The zero-based index value of the zone.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the reqested zone data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the specified zone's current value for the reverberation 
calculation method.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">value</span>)</span>
        - Sets the specified zone's current value for the reverberation calculation 
method.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="name"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">name</h3>
  <p>Returns the zone's name.</p>
  <p>Parameter(s) This property has no parameters.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>name A text string containing the zone's name.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Returns the zone's name.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">name</span>)</span>
        - Sets the specified zone's name.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="objects"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">objects</h3>
  <p>Returns the zone's object(s).</p>
  <p>Parameter(s) This property has no parameters.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>objects A list of objects belonging to this zone.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Returns the zone's object(s).
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="off"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">off</h3>
  <p>Retrieves the current off state of the specified zone. Off zones are 
  effectively removed from the mode and are not displayed or involved in 
  any calculations.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>result A boolean value where 1 represents true and 0 represents 
  false.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the current off state of the specified zone.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">state</span>=<span class="summary-sig-default">True</span>)</span>
        - Sets or resets the specified zone's off state.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="peak_cooling"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">peak_cooling</h3>
  <p>Retrieves the specified zone's current value for the peak cooling load
  (W).</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the reqested zone data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the specified zone's current value for the peak cooling load (W).
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">value</span>)</span>
        - Sets the specified zone's current value for the peak cooling load (W).
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="peak_heating"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">peak_heating</h3>
  <p>Retrieves the specified zone's current value for the peak heating load
  (W).</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the reqested zone data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the specified zone's current value for the peak heating load (W).
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">value</span>)</span>
        - Sets the specified zone's current value for the peak heating load (W).
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="random_colour"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">random_colour</h3>
  
  <dl class="fields">
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>)</span>
        - Sets the display colour of the specified zone to a random colour based on 
the current background.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="range"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">range</h3>
  <p>Retrieves the minimum, maximum and average temperature of the zone for
  the last calculated day.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>max The maximum temperature for the day, given in degrees Celcius.</p>
  <p>min The minimum temperature for the day, given in degrees Celcius.</p>
  <p>avg The average temperature over that day, given in degrees 
  Celcius.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the minimum, maximum and average temperature of the zone for the 
last calculated day.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="rel_humidity"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">rel_humidity</h3>
  <p>Retrieves the specified zone's current value for the design internal 
  relative humidity (%).</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the reqested zone data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the specified zone's current value for the design internal 
relative humidity (%).
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">value</span>)</span>
        - Sets the specified zone's current value for the design internal relative 
humidity (%).
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="response_factor"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">response_factor</h3>
  <p>Retrieves the specified zone's current value for the total zone 
  response factor.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the reqested zone data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the specified zone's current value for the total zone response 
factor.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">value</span>)</span>
        - Sets the specified zone's current value for the total zone response factor.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="selected"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">selected</h3>
  
  <dl class="fields">
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">state</span>=<span class="summary-sig-default">True</span>)</span>
        - Selects or deselects all objects in the specified zone.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="sensible_gains"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">sensible_gains</h3>
  <p>Retrieves the specified zone's current value for the sensible internal
  heat gains (W/m^2).</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the reqested zone data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the specified zone's current value for the sensible internal heat
gains (W/m^2).
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">value</span>)</span>
        - Sets the specified zone's current value for the sensible internal heat 
gains (W/m^2).
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="solar_gains"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">solar_gains</h3>
  <p>Retrieves the specified zone's current value for the total direct 
  solar gains through WINDOWS and transparent appertures.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the reqested zone data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the specified zone's current value for the total direct solar 
gains through WINDOWS and transparent appertures.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">value</span>)</span>
        - Sets the specified zone's current value for the total direct solar gains 
through WINDOWS and transparent appertures.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="surface_area"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">surface_area</h3>
  <p>Retrieves the specified zone's current value for the total zone 
  internal surface area (m^2).</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the reqested zone data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the specified zone's current value for the total zone internal 
surface area (m^2).
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">value</span>)</span>
        - Sets the specified zone's current value for the total zone internal surface
area (m^2).
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="system"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">system</h3>
  <p>Retrieves the HVAC system type for the specified zone.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>result An integer value corresponding to the following Zone HVAC 
  System Codes table.</p>
  <p>Relevant Data Table(s)</p>
  <p>Zone HVAC System Codes Token Value Description none 0 No HVAC or 
  ventilation system. natvent 1 Natural ventilation only. mixedmode 2 Mixed
  mode HVAC operation. airconditioning 3 Full-time HVAC operation. heating 
  4 Heating system only. cooling 5 Cooling system only.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the HVAC system type for the specified zone.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">type</span>)</span>
        - Sets the HVAC system type for the specified zone.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="thermal"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">thermal</h3>
  <p>Retrieves the current thermal state of the specified zone. Thermal 
  zones are treated as fully enclosed spaces or rooms for which volume, 
  temperature and acoustic data is calculated.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>result A boolean value where 1 represents true and 0 represents 
  false.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the current thermal state of the specified zone.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">state</span>=<span class="summary-sig-default">True</span>)</span>
        - Sets or resets the specified zone's thermal state.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="upper_band"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">upper_band</h3>
  <p>Retrieves the specified zone's current value for the upper comfort 
  band (deg celsius).</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the reqested zone data</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the specified zone's current value for the upper comfort band 
(deg celsius).
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">value</span>)</span>
        - Sets the specified zone's current value for the upper comfort band (deg 
celcius).
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="uvalue"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">uvalue</h3>
  <p>Retrieves the specified zone's current value for the total U-Value of 
  exposed surface area (Heat loss rate W/m K).</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the reqested zone data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the specified zone's current value for the total U-Value of 
exposed surface area (Heat loss rate W/m K).
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">value</span>)</span>
        - Sets the specified zone's current value for the total U-Value of exposed 
surface area (Heat loss rate W/m K).
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="ventilation_rate"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">ventilation_rate</h3>
  <p>Retrieves the specified zone's current value for the wind-driven 
  ventilation rate (ac/h).</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the reqested zone data</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the specified zone's current value for the wind-driven 
ventilation rate (ac/h).
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">value</span>)</span>
        - Sets the specified zone's current value for the wind-driven ventilation 
rate (ac/h).
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="volume"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">volume</h3>
  <p>Retrieves the specified zone's current value for the internal zone 
  volume (m^3).</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the reqested zone data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the specified zone's current value for the internal zone volume 
(m^3).
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">value</span>)</span>
        - Sets the specified zone's current value for the internal zone volume (m^3).
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="window_area"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">window_area</h3>
  <p>Retrieves the specified zone's current value for the total exposed 
  WINDOW area (m^2).</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the reqested zone data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the specified zone's current value for the total exposed WINDOW 
area (m^2).
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">value</span>)</span>
        - Sets the specified zone's current value for the total exposed WINDOW area 
(m^2).
    </dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Fri Aug 28 01:29:48 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
